// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Code generated by sidekick. DO NOT EDIT.
#![allow(rustdoc::redundant_explicit_links)]
#![allow(rustdoc::broken_intra_doc_links)]

/// Implements a client for the Cloud Filestore API.
///
/// # Example
/// ```
/// # tokio_test::block_on(async {
/// # use google_cloud_filestore_v1::client::CloudFilestoreManager;
/// let client = CloudFilestoreManager::builder().build().await?;
/// // use `client` to make requests to the Cloud Filestore API.
/// # gax::client_builder::Result::<()>::Ok(()) });
/// ```
///
/// # Service Description
///
/// Configures and manages Filestore resources.
///
/// Filestore Manager v1.
///
/// The `file.googleapis.com` service implements the Filestore API and
/// defines the following resource model for managing instances:
///
/// * The service works with a collection of cloud projects, named: `/projects/*`
/// * Each project has a collection of available locations, named: `/locations/*`
/// * Each location has a collection of instances and backups, named:
///   `/instances/*` and `/backups/*` respectively.
/// * As such, Filestore instances are resources of the form:
///   `/projects/{project_number}/locations/{location_id}/instances/{instance_id}`
///   and backups are resources of the form:
///   `/projects/{project_number}/locations/{location_id}/backup/{backup_id}`
///
/// Note that location_id must be a Google Cloud `zone` for instances, but
/// a Google Cloud `region` for backups; for example:
///
/// * `projects/12345/locations/us-central1-c/instances/my-filestore`
/// * `projects/12345/locations/us-central1/backups/my-backup`
///
/// # Configuration
///
/// To configure `CloudFilestoreManager` use the `with_*` methods in the type returned
/// by [builder()][CloudFilestoreManager::builder]. The default configuration should
/// work for most applications. Common configuration changes include
///
/// * [with_endpoint()]: by default this client uses the global default endpoint
///   (`https://file.googleapis.com`). Applications using regional
///   endpoints or running in restricted networks (e.g. a network configured
//    with [Private Google Access with VPC Service Controls]) may want to
///   override this default.
/// * [with_credentials()]: by default this client uses
///   [Application Default Credentials]. Applications using custom
///   authentication may need to override this default.
///
/// [with_endpoint()]: super::builder::cloud_filestore_manager::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::cloud_filestore_manager::ClientBuilder::credentials
/// [Private Google Access with VPC Service Controls]: https://cloud.google.com/vpc-service-controls/docs/private-connectivity
/// [Application Default Credentials]: https://cloud.google.com/docs/authentication#adc
///
/// # Pooling and Cloning
///
/// `CloudFilestoreManager` holds a connection pool internally, it is advised to
/// create one and the reuse it.  You do not need to wrap `CloudFilestoreManager` in
/// an [Rc](std::rc::Rc) or [Arc](std::sync::Arc) to reuse it, because it
/// already uses an `Arc` internally.
#[derive(Clone, Debug)]
pub struct CloudFilestoreManager {
    inner: std::sync::Arc<dyn super::stub::dynamic::CloudFilestoreManager>,
}

impl CloudFilestoreManager {
    /// Returns a builder for [CloudFilestoreManager].
    ///
    /// ```
    /// # tokio_test::block_on(async {
    /// # use google_cloud_filestore_v1::client::CloudFilestoreManager;
    /// let client = CloudFilestoreManager::builder().build().await?;
    /// # gax::client_builder::Result::<()>::Ok(()) });
    /// ```
    pub fn builder() -> super::builder::cloud_filestore_manager::ClientBuilder {
        gax::client_builder::internal::new_builder(
            super::builder::cloud_filestore_manager::client::Factory,
        )
    }

    /// Creates a new client from the provided stub.
    ///
    /// The most common case for calling this function is in tests mocking the
    /// client's behavior.
    pub fn from_stub<T>(stub: T) -> Self
    where
        T: super::stub::CloudFilestoreManager + 'static,
    {
        Self {
            inner: std::sync::Arc::new(stub),
        }
    }

    pub(crate) async fn new(
        config: gaxi::options::ClientConfig,
    ) -> gax::client_builder::Result<Self> {
        let inner = Self::build_inner(config).await?;
        Ok(Self { inner })
    }

    async fn build_inner(
        conf: gaxi::options::ClientConfig,
    ) -> gax::client_builder::Result<std::sync::Arc<dyn super::stub::dynamic::CloudFilestoreManager>>
    {
        if gaxi::options::tracing_enabled(&conf) {
            return Ok(std::sync::Arc::new(Self::build_with_tracing(conf).await?));
        }
        Ok(std::sync::Arc::new(Self::build_transport(conf).await?))
    }

    async fn build_transport(
        conf: gaxi::options::ClientConfig,
    ) -> gax::client_builder::Result<impl super::stub::CloudFilestoreManager> {
        super::transport::CloudFilestoreManager::new(conf).await
    }

    async fn build_with_tracing(
        conf: gaxi::options::ClientConfig,
    ) -> gax::client_builder::Result<impl super::stub::CloudFilestoreManager> {
        Self::build_transport(conf)
            .await
            .map(super::tracing::CloudFilestoreManager::new)
    }

    /// Lists all instances in a project for either a specified location
    /// or for all locations.
    pub fn list_instances(&self) -> super::builder::cloud_filestore_manager::ListInstances {
        super::builder::cloud_filestore_manager::ListInstances::new(self.inner.clone())
    }

    /// Gets the details of a specific instance.
    pub fn get_instance(&self) -> super::builder::cloud_filestore_manager::GetInstance {
        super::builder::cloud_filestore_manager::GetInstance::new(self.inner.clone())
    }

    /// Creates an instance.
    /// When creating from a backup, the capacity of the new instance needs to be
    /// equal to or larger than the capacity of the backup (and also equal to or
    /// larger than the minimum capacity of the tier).
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn create_instance(&self) -> super::builder::cloud_filestore_manager::CreateInstance {
        super::builder::cloud_filestore_manager::CreateInstance::new(self.inner.clone())
    }

    /// Updates the settings of a specific instance.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn update_instance(&self) -> super::builder::cloud_filestore_manager::UpdateInstance {
        super::builder::cloud_filestore_manager::UpdateInstance::new(self.inner.clone())
    }

    /// Restores an existing instance's file share from a backup.
    ///
    /// The capacity of the instance needs to be equal to or larger than the
    /// capacity of the backup (and also equal to or larger than the minimum
    /// capacity of the tier).
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn restore_instance(&self) -> super::builder::cloud_filestore_manager::RestoreInstance {
        super::builder::cloud_filestore_manager::RestoreInstance::new(self.inner.clone())
    }

    /// Revert an existing instance's file system to a specified snapshot.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn revert_instance(&self) -> super::builder::cloud_filestore_manager::RevertInstance {
        super::builder::cloud_filestore_manager::RevertInstance::new(self.inner.clone())
    }

    /// Deletes an instance.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn delete_instance(&self) -> super::builder::cloud_filestore_manager::DeleteInstance {
        super::builder::cloud_filestore_manager::DeleteInstance::new(self.inner.clone())
    }

    /// Lists all snapshots in a project for either a specified location
    /// or for all locations.
    pub fn list_snapshots(&self) -> super::builder::cloud_filestore_manager::ListSnapshots {
        super::builder::cloud_filestore_manager::ListSnapshots::new(self.inner.clone())
    }

    /// Gets the details of a specific snapshot.
    pub fn get_snapshot(&self) -> super::builder::cloud_filestore_manager::GetSnapshot {
        super::builder::cloud_filestore_manager::GetSnapshot::new(self.inner.clone())
    }

    /// Creates a snapshot.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn create_snapshot(&self) -> super::builder::cloud_filestore_manager::CreateSnapshot {
        super::builder::cloud_filestore_manager::CreateSnapshot::new(self.inner.clone())
    }

    /// Deletes a snapshot.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn delete_snapshot(&self) -> super::builder::cloud_filestore_manager::DeleteSnapshot {
        super::builder::cloud_filestore_manager::DeleteSnapshot::new(self.inner.clone())
    }

    /// Updates the settings of a specific snapshot.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn update_snapshot(&self) -> super::builder::cloud_filestore_manager::UpdateSnapshot {
        super::builder::cloud_filestore_manager::UpdateSnapshot::new(self.inner.clone())
    }

    /// Lists all backups in a project for either a specified location or for all
    /// locations.
    pub fn list_backups(&self) -> super::builder::cloud_filestore_manager::ListBackups {
        super::builder::cloud_filestore_manager::ListBackups::new(self.inner.clone())
    }

    /// Gets the details of a specific backup.
    pub fn get_backup(&self) -> super::builder::cloud_filestore_manager::GetBackup {
        super::builder::cloud_filestore_manager::GetBackup::new(self.inner.clone())
    }

    /// Creates a backup.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn create_backup(&self) -> super::builder::cloud_filestore_manager::CreateBackup {
        super::builder::cloud_filestore_manager::CreateBackup::new(self.inner.clone())
    }

    /// Deletes a backup.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn delete_backup(&self) -> super::builder::cloud_filestore_manager::DeleteBackup {
        super::builder::cloud_filestore_manager::DeleteBackup::new(self.inner.clone())
    }

    /// Updates the settings of a specific backup.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn update_backup(&self) -> super::builder::cloud_filestore_manager::UpdateBackup {
        super::builder::cloud_filestore_manager::UpdateBackup::new(self.inner.clone())
    }

    /// Promote the standby instance (replica).
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn promote_replica(&self) -> super::builder::cloud_filestore_manager::PromoteReplica {
        super::builder::cloud_filestore_manager::PromoteReplica::new(self.inner.clone())
    }

    /// Lists information about the supported locations for this service.
    pub fn list_locations(&self) -> super::builder::cloud_filestore_manager::ListLocations {
        super::builder::cloud_filestore_manager::ListLocations::new(self.inner.clone())
    }

    /// Gets information about a location.
    pub fn get_location(&self) -> super::builder::cloud_filestore_manager::GetLocation {
        super::builder::cloud_filestore_manager::GetLocation::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: longrunning::client::Operations
    pub fn list_operations(&self) -> super::builder::cloud_filestore_manager::ListOperations {
        super::builder::cloud_filestore_manager::ListOperations::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: longrunning::client::Operations
    pub fn get_operation(&self) -> super::builder::cloud_filestore_manager::GetOperation {
        super::builder::cloud_filestore_manager::GetOperation::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: longrunning::client::Operations
    pub fn delete_operation(&self) -> super::builder::cloud_filestore_manager::DeleteOperation {
        super::builder::cloud_filestore_manager::DeleteOperation::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: longrunning::client::Operations
    pub fn cancel_operation(&self) -> super::builder::cloud_filestore_manager::CancelOperation {
        super::builder::cloud_filestore_manager::CancelOperation::new(self.inner.clone())
    }
}
